Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: [FC-0070] rendering library content in unit page #35785

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: [FC-0070] rendering library content in unit page #35785

wants to merge 1 commit into from
+107 −24

Conversation

ihor-romaniuk
Copy link
Contributor

@ihor-romaniuk ihor-romaniuk commented Nov 6, 2024 •
edited
Loading

🚨 Dependencies:

Description

This feature introduces functionalities to improve XBlock interactions within iframes:

  • Add styles that adopt default styles for Library Content which renders chromless template via iframe in MFE Authoring.
  • When the isIframeEmbed option is enabled, the XBlock sends a postMessage to the parent window. When sending such a message, the standard link transition is cancelled and the transition is carried out in MFE Authoring.
Unit_Library_Content.mov

Related Pull Requests

Testing instructions

  • Create a new course.
  • Create several units.
  • Open the course unit page.
  • Add a Library xBlock to the unit.
  • Click the “View” button on the Library xBlock.

Note: The change requires rebuilding static assets with tutor dev exec lms opensx-assets build --env=dev

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 6, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 6, 2024 •
edited
Loading

Thanks for the pull request, @ihor-romaniuk!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@ihor-romaniuk ihor-romaniuk changed the title Romaniuk/children container for rendering library feat: [FC-0070] rendering library content in unit page Nov 6, 2024
@ihor-romaniuk ihor-romaniuk mentioned this pull request Nov 6, 2024
Open
@ihor-romaniuk ihor-romaniuk added the FC Relates to an Axim Funded Contribution project label Nov 7, 2024
This was referenced Nov 12, 2024
Draft
Draft
@ihor-romaniuk ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from ea6c563 to 7e3ef8a Compare November 22, 2024 17:50
@ihor-romaniuk ihor-romaniuk marked this pull request as ready for review November 22, 2024 17:50
PKulkoRaccoonGang
PKulkoRaccoonGang suggested changes Nov 26, 2024
View reviewed changes
cms/static/js/views/pages/container.js
@@ -717,10 +718,6 @@ function($, _, Backbone, gettext, BasePage,
this.deleteComponent(this.findXBlockElement(event.target));
},

createPlaceholderElement: function() {
return $('<div/>', {class: 'studio-xblock-wrapper'});
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[question]: Is this method necessary for the legacy functionality to work correctly? Should we remove it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicated method in the file. https://github.com/openedx/edx-platform/pull/35785/files/7e3ef8a3ce97fa588a7296c9dad16eacd7d1883a#diff-1b7855448b6086c2a313e0b9ecff179e991106aac52648d880f6f9d551e64577L585

cms/static/sass/course-unit-mfe-iframe-bundle.scss Outdated
line-height: 22px;
border-radius: 4px;
padding: ($baseline * 1.2);
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.15), 0 1px 4px rgba(0, 0, 0, 0.15);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[code health]: I see that in this file we write the value of opacity both with and without zero (for example .15). Let's stick to the existing trend and write without 0 (0.15).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@ihor-romaniuk ihor-romaniuk force-pushed the romaniuk/children-container-for-rendering-library branch from 7e3ef8a to 41a4092 Compare November 26, 2024 12:37
@bradenmacdonald
Copy link
Contributor

Testing instructions

Testing instructions are missing a rebuild of static assets. This PR didn't work for me until I ran tutor dev exec lms openedx-assets build --env=dev

bradenmacdonald
bradenmacdonald reviewed Nov 28, 2024
View reviewed changes
cms/static/js/views/pages/container.js
{
type: 'handleViewXBlockContent',
payload: {
destination: event.currentTarget.href || '',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if we can also send the usageId as a separate parameter in the payload here, instead of making the MFE parse it (const newUnitId = payload.destination.split('/').pop()).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald left review comments

@PKulkoRaccoonGang PKulkoRaccoonGang PKulkoRaccoonGang requested changes

@arbrandes arbrandes Awaiting requested review from arbrandes

At least 1 approving review is required to merge this pull request.

Assignees

@ihor-romaniuk ihor-romaniuk

Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Ready for Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ihor-romaniuk @openedx-webhooks @bradenmacdonald @PKulkoRaccoonGang